home *** CD-ROM | disk | FTP | other *** search
/ Graphics Plus / Graphics Plus.iso / msdos / utils / pvgen1.lzh / pvlib.ref < prev    next >
Encoding:
Text File  |  1992-06-22  |  7.7 KB  |  249 lines
  1.         PVLIB Variables Description (page 1 of 1)
  2.        -------------------------------------------
  3.  
  4.  
  5.               /------------------------\
  6.               | Data Structure POVData |
  7.               \------------------------/
  8.  
  9. Data Type  Name                Description
  10. ---------  ----                -----------
  11. double     pd->x1              X Coordinate, Vector 1
  12. double     pd->y1              Y Coordinate, Vector 1
  13. double     pd->z1              X Coordinate, Vector 1
  14. double     pd->x2              X Coordinate, Vector 2
  15. double     pd->y2              Y Coordinate, Vector 2
  16. double     pd->z2              Z Coordinate, Vector 2
  17. double     pd->x3              X Coordinate, Vector 3
  18. double     pd->y3              Y Coordinate, Vector 3
  19. double     pd->z3              Z Coordinate, Vector 3
  20. double     pd->xMidpt          Midpoint (cylinders - x)
  21. double     pd->yMidpt          Midpoint (cylinders - y)
  22. double     pd->zMidpt          Midpoint (cylinders - z)
  23. double     pd->xTrans          Translation Factor (x)
  24. double     pd->yTrans          Translation Factor (y)
  25. double     pd->zTrans          Translation Factor (z)
  26. double     pd->xScale          Scale       Factor (x)
  27. double     pd->yScale          Scale       Factor (y)
  28. double     pd->zScale          Scale       Factor (z)
  29. double     pd->radius          Radius (sphere, cylinders)
  30. double     pd->aspect          Screen Aspect Ratio
  31. double     pd->LocX            Scene Viewpoint    (X Coordinate)
  32. double     pd->LocY            Scene Viewpoint    (Y Coordinate)
  33. double     pd->LocZ            Scene Viewpoint    (Z Coordinate)
  34. double     pd->AtX             Center of Interest (Z Coordinate)
  35. double     pd->AtY             Center of Interest (Z Coordinate)
  36. double     pd->AtZ             Center of Interest (Z Coordinate)
  37.  
  38.  
  39.  
  40.                 /------------------------\
  41.                 | Data Structure POVFile |
  42.                 \------------------------/
  43.  
  44. Data Type  Name                Description
  45. ---------  ----                -----------
  46. char       pf->FileStat        File Creation Status   (ON/OFF)
  47. char       pf->ObjStat         Object Creation Status (ON/OFF)
  48. char       pf->CapCyl          Capped Cylinder Status (ON/OFF)
  49. char       pf->FileFormat      Output File Type       (DKB/POV)
  50. char       pf->Object          POV Object Name
  51. char       pf->FileIn          Input  File Name
  52. char       pf->FileName        Output File Name
  53. FILE(*)    pf->in              Input  File Handle
  54. FILE(*)    pf->out             Output FIle Handle
  55.  
  56.  
  57.  
  58.             PVLIB Functions List (Page 1 of 1)
  59.             ------------------------------------
  60.  
  61.  
  62. Function Name        Description
  63. -------------        -----------
  64.  
  65. void  pvACube(void)  Add Cube to POV File
  66.  
  67. void  pvAXCyl(void)  Add X Cylinder to POV File
  68.  
  69. void  pvAYCyl(void)  Add Y Cylinder to POV File
  70.  
  71. void  pvAZCyl(void)  Add Z Cylinder to POV File
  72.  
  73. void   pvASph(void)  Add Sphere to POV File
  74.  
  75. void   pvATri(void)  Add Triangle to POV File
  76.  
  77. int    pvAInc(void)  Add Include Defs to POV File
  78.  
  79. int   pvAView(void)  Add ViewPoint to POV File
  80.  
  81. int  pvALight(void)  Add Light Source to POV File
  82.  
  83. int   pvSFile(void)  Open  POV File
  84.  
  85. int   pvEFile(void)  Close POV File
  86.  
  87. int    pvSObj(void)  Start POV Object/Union
  88.  
  89. int    pvEObj(void)  End   POV Object/Union
  90.  
  91.  
  92.   
  93.  
  94.             PVLIB Functions Description (page 1 of 3)
  95.             -------------------------------------------
  96.  
  97. void  pvACube(void)  - Add Cube to POV File
  98.  
  99.    INPUT -   pd->x1 - Lower, Left,  Close (x)
  100.              pd->y1 - Lower, Left,  Close (y)
  101.              pd->z1 - Lower, Left,  Close (x)
  102.              pd->x2 - Upper, Right, Far   (x)
  103.              pd->y2 - Upper, Right, Far   (y)
  104.              pd->z2 - Upper, Right, Far   (z)              
  105.  
  106.    RETURNS - n/a
  107.  
  108. ----------------------------------------------------------------
  109.  
  110. void  pvAXCyl(void)  - Add X Cylinder to POV File
  111.  
  112.    INPUT -   pd->x1     - Left   Coordinate (x)
  113.              pd->x2     - Right  Coordinate (x)
  114.              pd->y1     - Y Axis Coordinate
  115.              pd->z1     - Z Axis Coordinate
  116.              pd->radius - Cylinder Radius              
  117.  
  118.    RETURNS - n/a
  119.  
  120. ----------------------------------------------------------------
  121.  
  122. void  pvAYCyl(void)  - Add Y Cylinder to POV File
  123.  
  124.    INPUT -   pd->y1     - Bottom Coordinate (y)
  125.              pd->y2     - Top    Coordinate (y)
  126.              pd->x1     - X Axis Coordinate
  127.              pd->z1     - Z Axis Coordinate
  128.              pd->radius - Cylinder Radius              
  129.  
  130.    RETURNS - n/a
  131.  
  132. ----------------------------------------------------------------
  133.  
  134. void  pvAZCyl(void)  - Add Z Cylinder to POV File
  135.  
  136.    INPUT -   pd->z1     - Close  Coordinate (z)
  137.              pd->z2     - Far    Coordinate (z)
  138.              pd->x1     - X Axis Coordinate
  139.              pd->y1     - Y Axis Coordinate
  140.              pd->radius - Cylinder Radius              
  141.  
  142.    RETURNS - n/a
  143.  
  144.   
  145.  
  146.             PVLIB Functions Description (page 2 of 3)
  147.             -------------------------------------------
  148.  
  149. void   pvASph(void)  - Add Sphere to POV File
  150.  
  151.    INPUT -   pd->x1     - Sphere Origin (x)
  152.              pd->y1     - Sphere Origin (y)
  153.              pd->z1     - Sphere Origin (z)
  154.              pd->radius - Sphere Radius              
  155.  
  156.    RETURNS - n/a
  157.  
  158. ----------------------------------------------------------------
  159.  
  160. void   pvATri(void)  - Add Triangle to POV File
  161.  
  162.    INPUT -   pd->x1 - Triangle Vertex  1 (x)
  163.              pd->y1 - Triangle Vertex  1 (y)
  164.              pd->z1 - Triangle Vertex  1 (z)
  165.              pd->x2 - Triangle Vertex  2 (x)
  166.              pd->y2 - Triangle Vertex  2 (y)
  167.              pd->z2 - Triangle Vertex  2 (z)
  168.              pd->x3 - Triangle Vertex  3 (x)
  169.              pd->y3 - Triangle Vertex  3 (y)
  170.              pd->z3 - Triangle Vertex  3 (z)
  171.  
  172.    RETURNS - n/a
  173.  
  174. ----------------------------------------------------------------
  175.  
  176. int    pvAInc(void)  - Add Include Defs to POV File
  177.  
  178.    INPUT -   n/a
  179.  
  180.    RETURNS - 0 = Successful
  181.              1 = Error
  182.  
  183. ----------------------------------------------------------------
  184.  
  185. int   pvAView(void)  - Add ViewPoint to POV File
  186.  
  187.    INPUT -   pd->LocX   - Viewpoint Location (x)
  188.              pd->LocY   - Viewpoint Location (y)
  189.              pd->LocZ   - Viewpoint Location (z)
  190.              pd->AtX    - Center of Interest (x)
  191.              pd->AtY    - Center of Interest (y)
  192.              pd->AtZ    - Center of Interest (z)
  193.              pd->aspect - Screen Aspect Ratio
  194.  
  195.    RETURNS - 0 = Successful
  196.              1 = Error
  197.  
  198.   
  199.  
  200.             PVLIB Functions Description (page 3 of 3)
  201.             -------------------------------------------
  202.  
  203.  
  204. int  pvALight(void)  - Add Light Source to POV File
  205.  
  206.    INPUT -   pd->x1 - Light Source Location (x)
  207.              pd->y1 - Light Source Location (y)
  208.              pd->z1 - Light Source Location (z)
  209.  
  210.    RETURNS - 0 = Successful
  211.              1 = Error
  212.  
  213. ----------------------------------------------------------------
  214.  
  215. int   pvSFile(void)  - Open POV File
  216.  
  217.    INPUT -   pf->FileName - POV File Name
  218.  
  219.    RETURNS - 0 = Successful
  220.              1 = Error
  221.  
  222. ----------------------------------------------------------------
  223.  
  224. int   pvEFile(void)  - Close POV File
  225.  
  226.    INPUT -   n/a
  227.  
  228.    RETURNS - 0 = Successful
  229.              1 = Error
  230.  
  231. ----------------------------------------------------------------
  232.  
  233. int    pvSObj(void)  - Start POV Object/Union
  234.  
  235.    INPUT -   pf->Object - POV Object Name
  236.  
  237.    RETURNS - 0 = Successful
  238.              1 = Error
  239.  
  240. ----------------------------------------------------------------
  241.  
  242. int    pvEObj(void)  - End POV Object/Union
  243.  
  244.    INPUT -   n/a
  245.  
  246.    RETURNS - 0 = Successful
  247.              1 = Error
  248.  
  249.